home *** CD-ROM | disk | FTP | other *** search
/ Dr. Windows 3 / dr win3.zip / dr win3 / COMMUNIC / GC101C.ZIP / GOCIS.BTN < prev    next >
Text File  |  1993-11-20  |  17KB  |  573 lines
  1.  
  2. ;**************************************************************************
  3. ;  GoCIS User defined button bar L.Lee 6/30/93
  4. ;**************************************************************************
  5. ;
  6. ; You can redefine buttons to tailor GoCIS to your style and needs.
  7. ; This is an example of such a button definition file.
  8. ; up to 128 buttons can be defined in a single file.  If you need
  9. ; more than this I suggest having one button load a separate
  10. ; button file..
  11. ;
  12. ;* [DEFINED.FORMAT] *******************************************************
  13. ;
  14. ; Some have expressed the need to display more than one row of buttons
  15. ; in this case you need to define an optional [DEFINED.FORMAT] section
  16. ; this the only section which is not considered a button.  In this
  17. ; section you can only define two fields (either of which are optional)
  18. ;
  19. ; Define &MaxRows = (1 to 3 defaults as 1)
  20. ;        This field defines the number of row of buttons when displayed
  21. ;        horizontially across the top or bottom on the display
  22. ;
  23. ; Define &MaxColumns = (1 to 3 defaults as 1)
  24. ;        This field defines the number of columns of buttons when displayed
  25. ;        Vertically down the left or right side of the display
  26. ;
  27. ;
  28. ;
  29. ;* [BUTTON NAME] **********************************************************
  30. ;
  31. ; You specify a button name by placing it in braces [name].  The
  32. ; name is used internally by GoCIS to identify the button. You can
  33. ; use any name you like as long as it is unique within the file.
  34. ;
  35. ; After the button name you specify the definition of several
  36. ; components. Any and all of these are optional.  The defined
  37. ; variables are used to initially display the button.  At the very
  38. ; least you should probably define the following:
  39. ;
  40. ;   DEFINE &CAPTION     =caption to display on the button
  41. ;   DEFINE &ICON        =the name of an icon (.ICO) file to display on
  42. ;                        the button
  43. ;   DEFINE &TITLE       =text to display as the mouse moves across the
  44. ;                        button
  45. ;   DEFINE &DRAGMODE    =can the button be dragged to a forum?
  46. ;                        (0=no, 1=yes)
  47. ;
  48. ; Finally comes the actions you'd like carried out as the button is pressed
  49. ; this consists of some verb or action and any parameters as appropriate
  50. ;
  51. ;  The following is a list of the commands and the actions
  52. ;
  53. ;  SET &variable        =value
  54. ;  &Variable            =value
  55. ;
  56. ;   The varibles that you can set are as follows:
  57. ;
  58. ;   &CAPTION    =caption to display on the button
  59. ;   &ICON       =the name of an icon (.ICO) file to display on the button
  60. ;   &TITLE      =text to display as the mouse moves across the button
  61. ;   &DRAGMODE   =can the button be dragged to a forum (0=no, 1=yes);
  62. ;   &CONFIG     =load a new configuration file
  63. ;   &SCOPE      =Set the scope of the action buttons to "VIEW" or "FORUM"
  64. ;   &VIEW       =display this view
  65. ;   &FORUM      =Make this the current forum
  66. ;   &BAUD       =set baud rate to this value
  67. ;   &PHONE      =set phone number to this value
  68. ;   &FIELD1..5  =user defined to do with as you please
  69. ;
  70. ;
  71. ; +ACTION       named-action
  72. ; -ACTION       named-action
  73. ;
  74. ;   The specified action can be set "+" or removed "-".  Actions that
  75. ;   can be named include:
  76. ;
  77. ;               Join.Forum
  78. ;               Set.Defaults
  79. ;               Update.Sections
  80. ;               Read.Announcements
  81. ;               Scan.New.Messages
  82. ;               Read.Messages
  83. ;               Send.Replies
  84. ;               Read.New.Messages
  85. ;               Read.Waiting.Messages
  86. ;               Scan.Libraries
  87. ;               Download.Files
  88. ;               Upload.Files
  89. ;
  90. ;       
  91. ;
  92. ; +PENDING      named-pending-state
  93. ; -PENDING      named-pending-state
  94. ;
  95. ;   The pending states are the flags that display the fact that
  96. ;   you have recieved messages, headers, and or catalogs.  Pending
  97. ;   states you can specify include:
  98. ;
  99. ;               LBR    (catalogs)
  100. ;               MSG    (messages)
  101. ;               MQS    (headers)
  102. ;
  103. ;
  104. ; LOAD          button-filename
  105. ;
  106. ;   Loads a new set of buttons from the specified file
  107. ;
  108. ; DO            ScriptfileName
  109. ; RUNSCRIPT     ScriptfileName
  110. ;
  111. ;   Both of these are the same and causes GoCIS to execute the given
  112. ;   communications script.  This of course means that GoCIS will be
  113. ;   loging on to CIS and performing some prescribed actions..
  114. ;
  115. ; RUN           window-state program parameters
  116. ; EXECUTE       window-state program parameters
  117. ; SHELL         window-state program parameters
  118. ;
  119. ;   All of these are the same and causes GoCIS to execute the given
  120. ;   program passing it the specifed parameters.  The window-state
  121. ;   is optional and defaults to NORMAL, but can be specified as
  122. ;   NORMAL, MAXIMIZED otr MINIMIZED.
  123. ;
  124. ; WAITAPP               Seconds or .fraction-of-second
  125. ; WAITSTART             Seconds or .fraction-of-second
  126. ; WAITEND
  127. ;
  128. ;   Each of these commands can cause GoCIS to suspend execution
  129. ;   until a "SHELLED" application has started or completed.
  130. ;   WAITSTART   causes the button to pause (N) seconds for  the application to start
  131. ;   WAITEND     causes the button to pause until the application ends
  132. ;   WAITAPP     causes the button to pause (N) seconds for  the application to start
  133. ;               and then futher causes the button to pause until the application ends
  134. ;
  135. ;
  136. ;
  137. ; PAUSE         Seconds or .fraction-of-second
  138. ;
  139. ;   This causes the button to pause before continuing.  You can enter
  140. ;   decimal point to indicate a delay in fractions of a second as well.
  141. ;   This is useful after using the RUN command since many windows
  142. ;   programs need a few seconds before they are willing to accept commands
  143. ;
  144. ;
  145. ;
  146. ; SENDKEYS keystrokes
  147. ;
  148. ;   Defines the keystrokes to be simulated by the program
  149. ;
  150. ;
  151. ;   If you are already familiar with the VB SendKeys function you
  152. ;   already know the format of the keystrokes that can be sent
  153. ;   For those of you not familiar with this command the following
  154. ;   characters have special meaning:
  155. ;
  156. ;               '+' SHIFT
  157. ;               '^' CONTROL
  158. ;               '%' ALT
  159. ;
  160. ;   So to simulate an ALT-R you code %R
  161. ;   CONTROL-R would be ^R and so on...
  162. ;
  163. ;   The following keys can be simulated by enclosing them in braces {}
  164. ;
  165. ;   {ENTER} {HELP} {LEFT} {RIGHT} {UP} {DOWN} {PGDN} {PGUP} {F1 ... F12}
  166. ;
  167. ;   You can repeat a keystroke by specifing the key within braces and
  168. ;   specifing a count.  Fox example you can code:
  169. ;
  170. ;   {TAB}{TAB}{TAB}{TAB}   ot {TAB 4}
  171. ;
  172. ;
  173. ;  CONDITIONAL LOGIC...
  174. ;
  175. ;  IF.. THEN.. ENDIF
  176. ;  FOR.. NEXT...
  177. ;
  178. ;   This was never intended to be the do all language it does support
  179. ;   some very simple conditional commands that can be useful..
  180. ;
  181. ;   IF condition THEN
  182. ;     ...
  183. ;   ELSE
  184. ;      ...
  185. ;   ENDIF
  186. ;
  187. ;   if the condition is true the commands between the if and endif
  188. ;   are executed.  You can nest if's up to 20 deep.
  189. ;
  190. ;   There are 5 functions that are avaiable to be used only within an
  191. ;   "IF":
  192. ;
  193. ;       FileExists(filename)..  Returns true if the file exists
  194. ;       FileData(FileName)...   Returns date/time of the file
  195. ;       Today()...              Returns current date/time
  196. ;       Pending(state)...       Returns true if the state is pending
  197. ;       Action(flag)...         Returns true if the flag is set
  198. ;
  199. ;
  200. ;   FOR EACH FORUM
  201. ;      ...
  202. ;   NEXT
  203. ;
  204. ;   This is the only looping construct and it executes commands for between
  205. ;   FOR..NEXT for each forum listed in the current view...
  206. ;
  207. ;
  208. ;
  209. ;  <<<< ADDITIONAL NOTES >>>>>
  210. ;
  211. ;    Finally you can use GoCIS variable data that will be replaced when
  212. ;    the button is pressed with the value of a GoCIS field
  213. ;
  214. ;    For example instead of hard coding a user name you can
  215. ;    use the &UserName variable, for which GoCIS will substitute
  216. ;    the cis user name at the time the button os pressed.
  217. ;
  218. ;    The following variables can be used:
  219. ;
  220. ;       &Caption        Caption of the button
  221. ;       &Icon           Icon file name of the button
  222. ;       &Title          Title of the button
  223. ;       
  224. ;       &ExePath    Path to GoCIS.EXE
  225. ;
  226. ;       &ForumName
  227. ;